Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds delete forecast API #33401

Merged
merged 3 commits into from
Sep 6, 2018
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 4, 2018

Related to #33218 and #31134

@lcawl lcawl added >docs General docs changes WIP v7.0.0 :ml Machine learning v6.5.0 labels Sep 4, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core


`forecast_id`::
(string) A comma-separated list of forecast identifiers.
//TBD: Can this ID be retrieved somehow?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ID is only available from the initial creation of the forecast.

This API is most likely be utilized from the UI (and they know how to gather and display forecasts from the .ml-shared index, or as an "oops, I created a forecast via API with the wrong settings".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, so there are no immediate plans for a "GET forecasts" API?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lcawl no, there is not.

`allow_no_forecasts`::
(boolean) Whether to ignore if `_all` matches no forecasts.
//TBD: This description is unclear. Does this mean that if this parameter is
//false and there are no forecasts in the job, an error is returned?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, if _all finds that there are NO forecasts, then an error is returned when this is false. Rare use case for sure, but is consistent with other APIs that allow this type of interaction.

`timeout`::
(time units) Controls the time to wait until the forecasts are deleted.
Defaults to 30 seconds. For more information about time units, see <<time-units>>.
//TBD: This description is unclear. Is it the time to wait until the deletion
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to wait for the deletion to be complete.

@lcawl lcawl force-pushed the lcawley-delete-forecast branch from b808bf4 to c8423ae Compare September 5, 2018 23:55
@lcawl lcawl removed the WIP label Sep 6, 2018
Copy link
Member

@benwtrent benwtrent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks a bunch for writing this up @lcawl !!!

@lcawl lcawl merged commit 7441c03 into elastic:master Sep 6, 2018
@lcawl lcawl deleted the lcawley-delete-forecast branch September 6, 2018 16:24
lcawl added a commit that referenced this pull request Sep 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml Machine learning v6.5.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants